vcOneToManyInterface

vcOneToManyInterface is a behavior used for connecting a component to one or more components. This class supports multiple connections at the same time, but only a single "template" section can be defined.

See in: Overview

Module: vcBehaviors

Parent: vcSimInterface

Children -

Referenced by: -

Properties

Learn how to use properties here. The properties are also inherited from the parent class.

NameTypeAccessDescription
ConnectedComponentsvcList[vcComponent]RGets a list of all components connected to this interface.
See more
Each component appears only once in the list even if multiple connections exist.

Exceptions:
RuntimeError: When the owning component hasn't been initialized.
SectionsvcList[vcSimInterfaceSection]RGets a list of all sections in this interface.

Methods

Learn how to use methods here. The methods are also inherited from the parent class.

NameReturn TypeParametersDescription
createSectionvcSimInterfaceSectionString sectionNameSections can't be created into one to many interface.

Exceptions:
RuntimeError: Always.
disconnectBooleanOptional Keyword[otherInterface = vcSimInterface]Removes either all or a specific connection from this interface.
See more
Parameters:
Optional: otherInterface (vcSimInterface): Specific interface from which to disconnect. If not provided, all connections will be removed.

Returns:
bool: True when disconnection was successful, False otherwise.

Exceptions:
RuntimeError: Occurs when simulation node hierarchy is locked.